Restructure some pages to create new "Connecting" section#633
Open
peter-smith-phd wants to merge 3 commits intomainfrom
Open
Restructure some pages to create new "Connecting" section#633peter-smith-phd wants to merge 3 commits intomainfrom
peter-smith-phd wants to merge 3 commits intomainfrom
Conversation
Add a new top-level "Connecting" section grouping the docs needed to point an existing AWS application at LocalStack — AWS CLI, AWS SDKs, Infrastructure as Code, LocalStack Console, and the LocalStack Toolkit (IDEs) — with redirects, updated cross-references, and new Overview pages. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Deploying localstack-docs with
|
| Latest commit: |
af4f8ad
|
| Status: | 🚫 Build failed. |
peter-smith-phd
changed the title
Rename the section directory from connecting-to-localstack to connecting (shorter URL), rename its sidebar group to "IDE Extensions", and add an "AWS Toolkit for VS Code" page so the section covers both available IDE extensions. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
peter-smith-phd
requested review from
HarshCasper,
aidehn,
bentsku,
dfangl,
joe4dev,
k-a-il,
lukqw,
quetzalliwrites,
remotesynth and
silv-io
as code owners
| @@ -0,0 +1,17 @@ | |||
| --- | |||
| title: Overview | |||
| description: Connect to LocalStack from your IDE — install, configure, run, and inspect LocalStack without leaving your editor. | |||
Collaborator
There was a problem hiding this comment.
Suggested change
| description: Connect to LocalStack from your IDE — install, configure, run, and inspect LocalStack without leaving your editor. | |
| description: Connect to LocalStack from your IDE. Install, configure, run, and inspect LocalStack without leaving your editor. |
quetzalliwrites
requested changes
May 7, 2026
Collaborator
There was a problem hiding this comment.
Nice work, Peter!
Looking pretty great, amazing contribution. Thanks, Peter... I also love the plug icon for the nav; that was a great call. 🔌
Feedback Summary:
-
Redirect Files: There are a few more spots you need to hit to properly update our redirects (your changes to
public/_redirectscovered just one of them 😸). Please go ahead and update the redirects in these two files as well:scripts/redirects/aws_urls.txtscripts/redirects/_redirects
-
Style Consistency: For consistency, please avoid using em dashes in the documentation. We don't currently use them in our style guide (context: we've a Linear project in progress for the docs style guide release; as it's not live yet, i understand you wouldn't know this), and adding 4–5 pages with them suddenly makes the content look a bit "AI-written."
As soon as these are addressed, I am happy to approve, MERGE, and party with you.
|
|
||
| import SectionCards from '../../../../../components/SectionCards.astro'; | ||
|
|
||
| Use IDE extensions to install, configure, run, and inspect LocalStack alongside the code you are developing — without leaving your editor. The LocalStack Toolkit manages the LocalStack lifecycle from VS Code, and the AWS Toolkit for VS Code lets you browse and operate on the resources running on your LocalStack instance from a familiar AWS-style explorer. |
Collaborator
There was a problem hiding this comment.
Suggested change
| Use IDE extensions to install, configure, run, and inspect LocalStack alongside the code you are developing — without leaving your editor. The LocalStack Toolkit manages the LocalStack lifecycle from VS Code, and the AWS Toolkit for VS Code lets you browse and operate on the resources running on your LocalStack instance from a familiar AWS-style explorer. | |
| Use IDE extensions to install, configure, run, and inspect LocalStack alongside the code you are developing, without leaving your editor. The LocalStack Toolkit manages the LocalStack lifecycle from VS Code, and the AWS Toolkit for VS Code lets you browse and operate on the resources running on your LocalStack instance from a familiar AWS-style explorer. |
| @@ -0,0 +1,23 @@ | |||
| --- | |||
| title: Overview | |||
| description: Connect to LocalStack using the same AWS tools you already use — CLI, SDKs, IaC, the web console, and IDE integrations. | |||
Collaborator
There was a problem hiding this comment.
Suggested change
| description: Connect to LocalStack using the same AWS tools you already use — CLI, SDKs, IaC, the web console, and IDE integrations. | |
| description: Connect to LocalStack using your favorite AWS tools, such as CLI, SDKs, IaC, the web console, and IDE integrations. |
|
|
||
| import SectionCards from '../../../../components/SectionCards.astro'; | ||
|
|
||
| If you already run an application on AWS, you almost certainly connect to it through familiar tools — the AWS CLI, an AWS SDK, an Infrastructure as Code tool such as Terraform or AWS CDK, or an IDE plugin. Running that same application against LocalStack means continuing to use those tools; you only need to point them at LocalStack instead of AWS. |
Collaborator
There was a problem hiding this comment.
Suggested change
| If you already run an application on AWS, you almost certainly connect to it through familiar tools — the AWS CLI, an AWS SDK, an Infrastructure as Code tool such as Terraform or AWS CDK, or an IDE plugin. Running that same application against LocalStack means continuing to use those tools; you only need to point them at LocalStack instead of AWS. | |
| If you already run an application on AWS, you almost certainly connect to it through familiar tools, such as the AWS CLI, an AWS SDK, an Infrastructure as Code tool such as Terraform or AWS CDK, or an IDE plugin. Running that same application against LocalStack means continuing to use those tools; you only need to point them at LocalStack instead of AWS. |
Contributor
Author
|
Thanks for the review feedback. I made some changes and published a new revision:
A couple of notes:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
To better align with how the customers use our product, this PR creates a new top-level "Connecting" section. This section contains all the necessary documentation for an AWS user to learn how their existing tools (CLI, SDK, IaC) can be configured to work with LocalStack. This section does not introduce any LocalStack-specific features, but purely focuses on how existing tools can be used with LocalStack (which for many users is all they care about).
There have been (almost) no changes to existing pages, but rather the left-hand navigation has been modified to reflect the new structure.
Adds a new top-level Connecting section that groups the docs a user needs to point an existing AWS application at LocalStack:
integrations/aws-native-tools/integrations/aws-sdks/; page titles renamed to AWS's official names (e.g. "AWS SDK for .NET")tooling/, and introduction of new AWS Toolkit page.All existing pages have been updated to correctly link to these new pages, and redirects have been added/adjusted.
Linear: DOC-58
🤖 Generated with Claude Code